/**
 *    Copyright (C) 2008, 2009  Victor Smirnov <aist11@gmail.com>
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License along
 *    with this program; if not, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 *    See LICENSE.exceptions in the root folder of this project for possible
 *    exceptions
 *
 */

#ifndef _CUBEFS_API_COLLECTIONS_ITERATOR_HPP
#define	_CUBEFS_API_COLLECTIONS_ITERATOR_HPP

#include <cubefs/api/reflection.hpp>



namespace cubefs    {
namespace api       {

struct Model;

struct CUBEFS_API Iterator: public Typed {

    enum {ITER_EOF, ITER_EMPTY, ITER_BOF};

    virtual bool Next()             = 0;
    virtual bool Prev()             = 0;

    virtual void Close()            = 0;
    virtual bool IsClonable()       = 0;
    virtual Iterator* Clone()       = 0;
    virtual void GetValue(Typed *holder) = 0;

    virtual cubefs::api::Page* GetPage()    = 0;

    virtual bool IsFlag(Int flag)   = 0;

    virtual Model* GetModel()       = 0;

    static Type* MyType();
};

CUBEFS_DECLARE_TYPENAME(Iterator,    "cubefs::api::models::Iterator");

struct Page;

struct CUBEFS_API TreeMapIterator: public Iterator {
//    virtual cubefs::api::Page* GetPage()    = 0;
    virtual Int   GetIndex()                = 0;

    static Type* MyType();
};

CUBEFS_DECLARE_TYPENAME(TreeMapIterator,    "cubefs::api::models::TreeMapIterator");

struct CUBEFS_API IdxMapIterator: public TreeMapIterator {
    virtual BigInt GetBase(Int i)           = 0;

    static Type* MyType();
};

CUBEFS_DECLARE_TYPENAME(IdxMapIterator,    "cubefs::api::models::IdxMapIterator");

}
}


#endif
